Skip to content

Conversation

@shauryaMi12
Copy link
Contributor

Changes

Updated the module docstring in qlib/workflow/online/utils.py to improve readability and grammar. This text renders as the intro paragraph in the "Online Tool" docs section (via automodule in docs/component/online.rst).

Original (awkward phrasing):

OnlineTool is a module to set and unset a series of online models. The online models are some decisive models in some time points, which can be changed with the change of time. This allows us to use efficient submodels as the market-style changing.

Updated:

OnlineTool is a module for setting and unsetting a series of online models. These are key models selected at specific time points, which can evolve over time. This enables the use of efficient submodels in response to changing market conditions.

Why?

Enhances clarity and flow without altering technical meaning. No functional code changes.

Testing

Local Sphinx build confirmed the update renders correctly in component/online.html. No breaking changes.

Related

Improves https://qlib.readthedocs.io/en/latest/component/online.html

@shauryaMi12 shauryaMi12 changed the title Improved clarity for OnlineTool docstring docs: Improve OnlineTool docstring for clarity Oct 16, 2025
@SunsetWolf
Copy link
Collaborator

Hi, @shauryaMi12
Thanks for your contribution to qlib, the changes do make the semantics smoother, but I think the original format needs to be kept intact. I don't have permission to make changes in the main branch of your repo. So please do it yourself. Thank you for your time.

@shauryaMi12
Copy link
Contributor Author

Cool

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants